Cisco-IOS-XR-ipv4-igmp-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-igmp-cfg@2017-10-15.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
IGMP - Update
Update operation of resource: igmp
igmpbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGMP - Create
Create operation of resource: igmp
igmpbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IGMP - Delete
Delete operation of resource: igmp
Successful operation
Internal Error
Response Content-Types: application/json
IGMP - Retrieve
Retrieve operation of resource: igmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
TRAFFIC - Update
Update operation of resource: traffic
trafficbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Create
Create operation of resource: traffic
trafficbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Delete
Delete operation of resource: traffic
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Retrieve
Retrieve operation of resource: traffic
ID of vrf-name
Successful operation
Internal Error
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of vrf-name
Successful operation
Internal Error
SSM-ACCESS-GROUPS - Update
Update operation of resource: ssm-access-groups
ssm-access-groupsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Create
Create operation of resource: ssm-access-groups
ssm-access-groupsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Delete
Delete operation of resource: ssm-access-groups
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Retrieve
Retrieve operation of resource: ssm-access-groups
ID of vrf-name
Successful operation
Internal Error
SSM-ACCESS-GROUP - Update
Update operation of resource: ssm-access-group
ssm-access-groupbody object
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Create
Create operation of resource: ssm-access-group
ssm-access-groupbody object
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Delete
Delete operation of resource: ssm-access-group
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Retrieve
Retrieve operation of resource: ssm-access-group
ID of vrf-name
ID of source-address
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
JOIN-GROUPS - Update
Update operation of resource: join-groups
join-groupsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Create
Create operation of resource: join-groups
join-groupsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Delete
Delete operation of resource: join-groups
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Retrieve
Retrieve operation of resource: join-groups
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
JOIN-GROUP - Update
Update operation of resource: join-group
join-groupbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Create
Create operation of resource: join-group
join-groupbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Delete
Delete operation of resource: join-group
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Retrieve
Retrieve operation of resource: join-group
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
JOIN-GROUP-SOURCE-ADDRESS - Update
Update operation of resource: join-group-source-address
join-group-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Create
Create operation of resource: join-group-source-address
join-group-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Delete
Delete operation of resource: join-group-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: join-group-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
STATIC-GROUP-GROUP-ADDRESSES - Update
Update operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Create
Create operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Delete
Delete operation of resource: static-group-group-addresses
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Retrieve
Retrieve operation of resource: static-group-group-addresses
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
STATIC-GROUP-GROUP-ADDRESS - Update
Update operation of resource: static-group-group-address
static-group-group-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Create
Create operation of resource: static-group-group-address
static-group-group-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Delete
Delete operation of resource: static-group-group-address
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
DEFAULT-CONTEXT - Update
Update operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Create
Create operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Delete
Delete operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
NSF - Update
Update operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Create
Create operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Delete
Delete operation of resource: nsf
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Retrieve
Retrieve operation of resource: nsf
Successful operation
Internal Error
UNICAST-QOS-ADJUST - Update
Update operation of resource: unicast-qos-adjust
unicast-qos-adjustbody object
Request Content-Types: application/json
Request Example
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Create
Create operation of resource: unicast-qos-adjust
unicast-qos-adjustbody object
Request Content-Types: application/json
Request Example
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Delete
Delete operation of resource: unicast-qos-adjust
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: unicast-qos-adjust
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
ACCOUNTING - Update
Update operation of resource: accounting
accountingbody object
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Create
Create operation of resource: accounting
accountingbody object
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Delete
Delete operation of resource: accounting
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Retrieve
Retrieve operation of resource: accounting
Successful operation
Internal Error
TRAFFIC - Update
Update operation of resource: traffic
trafficbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Create
Create operation of resource: traffic
trafficbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Delete
Delete operation of resource: traffic
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Retrieve
Retrieve operation of resource: traffic
Successful operation
Internal Error
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
Successful operation
Internal Error
SSM-ACCESS-GROUPS - Update
Update operation of resource: ssm-access-groups
ssm-access-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Create
Create operation of resource: ssm-access-groups
ssm-access-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Delete
Delete operation of resource: ssm-access-groups
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Retrieve
Retrieve operation of resource: ssm-access-groups
Successful operation
Internal Error
SSM-ACCESS-GROUP - Update
Update operation of resource: ssm-access-group
ssm-access-groupbody object
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Create
Create operation of resource: ssm-access-group
ssm-access-groupbody object
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Delete
Delete operation of resource: ssm-access-group
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Retrieve
Retrieve operation of resource: ssm-access-group
ID of source-address
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
JOIN-GROUPS - Update
Update operation of resource: join-groups
join-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Create
Create operation of resource: join-groups
join-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Delete
Delete operation of resource: join-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Retrieve
Retrieve operation of resource: join-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
JOIN-GROUP - Update
Update operation of resource: join-group
join-groupbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Create
Create operation of resource: join-group
join-groupbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Delete
Delete operation of resource: join-group
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Retrieve
Retrieve operation of resource: join-group
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
JOIN-GROUP-SOURCE-ADDRESS - Update
Update operation of resource: join-group-source-address
join-group-source-addressbody object
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Create
Create operation of resource: join-group-source-address
join-group-source-addressbody object
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Delete
Delete operation of resource: join-group-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: join-group-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
STATIC-GROUP-GROUP-ADDRESSES - Update
Update operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Create
Create operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Delete
Delete operation of resource: static-group-group-addresses
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Retrieve
Retrieve operation of resource: static-group-group-addresses
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
STATIC-GROUP-GROUP-ADDRESS - Update
Update operation of resource: static-group-group-address
static-group-group-addressbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Create
Create operation of resource: static-group-group-address
static-group-group-addressbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Delete
Delete operation of resource: static-group-group-address
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-source-address-source-address-mask
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-source-address-source-address-mask
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of interface-name
Successful operation
Internal Error
AMT - Update
Update operation of resource: amt
amtbody object
Request Content-Types: application/json
Request Example
{ "amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255" "interface": "string", Relay Advertisement Interface
"address": "string" Anycast-Prefix Address
},
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295" "prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"
"address": "string" Anycast-Prefix Address
},
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"
"gateway-filter": "string", Access list for Gateway Filter
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AMT - Create
Create operation of resource: amt
amtbody object
Request Content-Types: application/json
Request Example
{ "amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255" "interface": "string", Relay Advertisement Interface
"address": "string" Anycast-Prefix Address
},
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295" "prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"
"address": "string" Anycast-Prefix Address
},
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"
"gateway-filter": "string", Access list for Gateway Filter
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AMT - Delete
Delete operation of resource: amt
Successful operation
Internal Error
Response Content-Types: application/json
AMT - Retrieve
Retrieve operation of resource: amt
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255" "interface": "string", Relay Advertisement Interface
"address": "string" Anycast-Prefix Address
},
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295" "prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"
"address": "string" Anycast-Prefix Address
},
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"
"gateway-filter": "string", Access list for Gateway Filter
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"
}
}
RELAY-ADV-ADD - Update
Update operation of resource: relay-adv-add
relay-adv-addbody object
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ADV-ADD - Create
Create operation of resource: relay-adv-add
relay-adv-addbody object
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ADV-ADD - Delete
Delete operation of resource: relay-adv-add
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ADV-ADD - Retrieve
Retrieve operation of resource: relay-adv-add
Successful operation
Internal Error
RELAY-ANYCAST-PREFIX - Update
Update operation of resource: relay-anycast-prefix
relay-anycast-prefixbody object
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ANYCAST-PREFIX - Create
Create operation of resource: relay-anycast-prefix
relay-anycast-prefixbody object
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ANYCAST-PREFIX - Delete
Delete operation of resource: relay-anycast-prefix
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-ANYCAST-PREFIX - Retrieve
Retrieve operation of resource: relay-anycast-prefix
Successful operation
Internal Error
MLD - Update
Update operation of resource: mld
mldbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLD - Create
Create operation of resource: mld
mldbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MLD - Delete
Delete operation of resource: mld
Successful operation
Internal Error
Response Content-Types: application/json
MLD - Retrieve
Retrieve operation of resource: mld
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}, "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
},
"vrf-name": "string", Name for this vrf "profile": "string" Configure the route-policy profile
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
]
}
TRAFFIC - Update
Update operation of resource: traffic
trafficbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Create
Create operation of resource: traffic
trafficbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Delete
Delete operation of resource: traffic
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Retrieve
Retrieve operation of resource: traffic
ID of vrf-name
Successful operation
Internal Error
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of vrf-name
Successful operation
Internal Error
SSM-ACCESS-GROUPS - Update
Update operation of resource: ssm-access-groups
ssm-access-groupsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Create
Create operation of resource: ssm-access-groups
ssm-access-groupsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Delete
Delete operation of resource: ssm-access-groups
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Retrieve
Retrieve operation of resource: ssm-access-groups
ID of vrf-name
Successful operation
Internal Error
SSM-ACCESS-GROUP - Update
Update operation of resource: ssm-access-group
ssm-access-groupbody object
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Create
Create operation of resource: ssm-access-group
ssm-access-groupbody object
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Delete
Delete operation of resource: ssm-access-group
ID of vrf-name
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Retrieve
Retrieve operation of resource: ssm-access-group
ID of vrf-name
ID of source-address
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
JOIN-GROUPS - Update
Update operation of resource: join-groups
join-groupsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Create
Create operation of resource: join-groups
join-groupsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Delete
Delete operation of resource: join-groups
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Retrieve
Retrieve operation of resource: join-groups
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
JOIN-GROUP - Update
Update operation of resource: join-group
join-groupbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Create
Create operation of resource: join-group
join-groupbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Delete
Delete operation of resource: join-group
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Retrieve
Retrieve operation of resource: join-group
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
JOIN-GROUP-SOURCE-ADDRESS - Update
Update operation of resource: join-group-source-address
join-group-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Create
Create operation of resource: join-group-source-address
join-group-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Delete
Delete operation of resource: join-group-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: join-group-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
STATIC-GROUP-GROUP-ADDRESSES - Update
Update operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Create
Create operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Delete
Delete operation of resource: static-group-group-addresses
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Retrieve
Retrieve operation of resource: static-group-group-addresses
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
STATIC-GROUP-GROUP-ADDRESS - Update
Update operation of resource: static-group-group-address
static-group-group-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Create
Create operation of resource: static-group-group-address
static-group-group-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Delete
Delete operation of resource: static-group-group-address
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address
ID of vrf-name
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-source-address
ID of vrf-name
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of vrf-name
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
DEFAULT-CONTEXT - Update
Update operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Create
Create operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Delete
Delete operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}, "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}, {
"access-list-name": "string", Access-list to account for
"source-address": "string" IP source address
}
]
},
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2" "maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
}, "lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"
}, "profile": "string" Configure the route-policy profile
}, "max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"
}, {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
}
NSF - Update
Update operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Create
Create operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Delete
Delete operation of resource: nsf
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Retrieve
Retrieve operation of resource: nsf
Successful operation
Internal Error
UNICAST-QOS-ADJUST - Update
Update operation of resource: unicast-qos-adjust
unicast-qos-adjustbody object
Request Content-Types: application/json
Request Example
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Create
Create operation of resource: unicast-qos-adjust
unicast-qos-adjustbody object
Request Content-Types: application/json
Request Example
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Delete
Delete operation of resource: unicast-qos-adjust
Successful operation
Internal Error
Response Content-Types: application/json
UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: unicast-qos-adjust
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"
}
}
ACCOUNTING - Update
Update operation of resource: accounting
accountingbody object
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Create
Create operation of resource: accounting
accountingbody object
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Delete
Delete operation of resource: accounting
Successful operation
Internal Error
Response Content-Types: application/json
ACCOUNTING - Retrieve
Retrieve operation of resource: accounting
Successful operation
Internal Error
TRAFFIC - Update
Update operation of resource: traffic
trafficbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Create
Create operation of resource: traffic
trafficbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Delete
Delete operation of resource: traffic
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC - Retrieve
Retrieve operation of resource: traffic
Successful operation
Internal Error
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "access-group": "string", Access list specifying access group range "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access list specifying tracking group range
}, "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access list specifying tracking group range
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
Successful operation
Internal Error
SSM-ACCESS-GROUPS - Update
Update operation of resource: ssm-access-groups
ssm-access-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Create
Create operation of resource: ssm-access-groups
ssm-access-groupsbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Delete
Delete operation of resource: ssm-access-groups
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUPS - Retrieve
Retrieve operation of resource: ssm-access-groups
Successful operation
Internal Error
SSM-ACCESS-GROUP - Update
Update operation of resource: ssm-access-group
ssm-access-groupbody object
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Create
Create operation of resource: ssm-access-group
ssm-access-groupbody object
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Delete
Delete operation of resource: ssm-access-group
ID of source-address
Successful operation
Internal Error
Response Content-Types: application/json
SSM-ACCESS-GROUP - Retrieve
Retrieve operation of resource: ssm-access-group
ID of source-address
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"access-group": "string", Access list specifying access group range
"interface-name": "string", Name of the interface {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" IP source address
}
]
}, {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
},
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60" "enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively
"access-list-name": "string" Access-list to account for
},
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second" "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
},
"version": "integer", Version number
range: "1..3"
default: "3"
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively
}
]
}
JOIN-GROUPS - Update
Update operation of resource: join-groups
join-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Create
Create operation of resource: join-groups
join-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Delete
Delete operation of resource: join-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUPS - Retrieve
Retrieve operation of resource: join-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
}
JOIN-GROUP - Update
Update operation of resource: join-group
join-groupbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Create
Create operation of resource: join-group
join-groupbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Delete
Delete operation of resource: join-group
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP - Retrieve
Retrieve operation of resource: join-group
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-address": "string", IP group address
"mode": "string" Filter mode
}
], {
"group-address": "string", IP group address
"mode": "string", Filter mode
"source-address": "string" Optional IP source address
}
]
}
JOIN-GROUP-SOURCE-ADDRESS - Update
Update operation of resource: join-group-source-address
join-group-source-addressbody object
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Create
Create operation of resource: join-group-source-address
join-group-source-addressbody object
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Delete
Delete operation of resource: join-group-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
JOIN-GROUP-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: join-group-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
STATIC-GROUP-GROUP-ADDRESSES - Update
Update operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Create
Create operation of resource: static-group-group-addresses
static-group-group-addressesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Delete
Delete operation of resource: static-group-group-addresses
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESSES - Retrieve
Retrieve operation of resource: static-group-group-addresses
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
}
STATIC-GROUP-GROUP-ADDRESS - Update
Update operation of resource: static-group-group-address
static-group-group-addressbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Create
Create operation of resource: static-group-group-address
static-group-group-addressbody object
ID of interface-name
ID of group-address
Request Content-Types: application/json
Request Example
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Delete
Delete operation of resource: static-group-group-address
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address
ID of interface-name
ID of group-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
], {
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
]
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-source-address
static-group-group-address-source-addressbody object
ID of interface-name
ID of group-address source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-source-address
ID of interface-name
ID of group-address source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"group-address": "string", IP group address
"source-address": "string", IP source address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-source-address-source-address-mask
static-group-group-address-source-address-source-address-maskbody object
ID of interface-name
ID of group-address source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-source-address-source-address-mask
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-source-address-source-address-mask
ID of interface-name
ID of group-address source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask
static-group-group-address-group-address-maskbody object
ID of interface-name
ID of group-address group-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask
ID of interface-name
ID of group-address group-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address
static-group-group-address-group-address-mask-source-addressbody object
ID of interface-name
ID of group-address group-address-mask source-address
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address
ID of interface-name
ID of group-address group-address-mask source-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update
Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create
Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
static-group-group-address-group-address-mask-source-address-source-address-maskbody object
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete
Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve
Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask
ID of interface-name
ID of group-address group-address-mask source-address source-address-mask
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"
"source-address": "string", IP source address
"group-address-mask": "string", Mask for Group Address
"source-address-mask": "string", Mask for Source Address
"group-address": "string", IP group address
"suppress-report": "boolean" Suppress reports
}
}
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update
Update operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create
Create operation of resource: maximum-groups-per-interface-oor
maximum-groups-per-interface-oorbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete
Delete operation of resource: maximum-groups-per-interface-oor
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve
Retrieve operation of resource: maximum-groups-per-interface-oor
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"
"access-list-name": "string" Access-list to account for
}
}
EXPLICIT-TRACKING - Update
Update operation of resource: explicit-tracking
explicit-trackingbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Create
Create operation of resource: explicit-tracking
explicit-trackingbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Delete
Delete operation of resource: explicit-tracking
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-TRACKING - Retrieve
Retrieve operation of resource: explicit-tracking
ID of interface-name
Successful operation
Internal Error